Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken cross links in docs #392

Closed
wants to merge 1 commit into from
Closed

Fix broken cross links in docs #392

wants to merge 1 commit into from

Conversation

lucyleeow
Copy link
Collaborator

@lucyleeow lucyleeow commented Apr 6, 2024 •
edited
Loading

Our doc build has the following broken link warnings:

/home/runner/work/docs/docs/docs/docs/developers/architecture/app_model.md:39: WARNING: 'myst' cross-reference target not found: 'appp-model-menus' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/naps/9-multiple-canvases.md:168: WARNING: 'myst' cross-reference target not found: 'Implementation' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/naps/9-multiple-canvases.md:224: WARNING: 'myst' cross-reference target not found: 'UI-Design-and-Architecture' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/naps/9-multiple-canvases.md:78: WARNING: 'myst' cross-reference target not found: 'UI-Design-and-Architecture' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/release/release_0_4_19.md:72: WARNING: 'myst' cross-reference target not found: 'Deprecations' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/tutorials/processing/dask.md:207: WARNING: 'myst' cross-reference target not found: 'make-your-life-easier-with-dask-image' [myst.xref_missing]
/home/runner/work/docs/docs/docs/docs/tutorials/processing/dask.md:329: WARNING: 'myst' cross-reference target not found: 'brain_dataset_tutorial.md' [myst.xref_missing]

I've just used reference labels when the original title (?) labels have broken, reference labels seem easier and less brittle.

Note the last one, AFAICT there originally was a PR to add a brain_dataset_tutorial/md file: napari/napari.github.io#64

But what got merged was: #132 where that example was just added to the dask.md file, so I've removed that reference from the list.

@lucyleeow lucyleeow added the bug Something isn't working label Apr 6, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 6, 2024
psobolewskiPhD
psobolewskiPhD requested changes Apr 6, 2024
View reviewed changes
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some suggestions to fix some issues with the links.
Thanks for catching these!
Also, could you fix the 0.4.19 release notes? I can't easily suggest, but here:

docs/docs/release/release_0_4_19.md

Line 72 in d3d36cd

See the ["Deprecations" section below](#Deprecations) for more information on

I think it needs to be (#deprecations) (lower case d)

docs/naps/9-multiple-canvases.md
Comment on lines +167 to +168
(nap_9_design_and_architecture)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(nap_9_design_and_architecture)
(nap_9_design_and_architecture)=

Right now the link in the footer doesn't work, because this renders like this:
image

I think this should fix it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤦 I must have done this half asleep, will fix!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no worries 😄
and no rush!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually we can just use the old label, what doesn't work is the capitalization. So we can just change the reference to read (#ui-design-and-architecture)

docs/naps/9-multiple-canvases.md
Comment on lines +199 to +200
(nap_9_implementation)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(nap_9_implementation)
(nap_9_implementation)=

Same as above, the link doesn't work.

docs/tutorials/processing/dask.md
Comment on lines +114 to +115
(dask_image)=

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(dask_image)=
(dask_image)=

Right now the link below doesn't work. I think this is the fix.

@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Apr 6, 2024
melissawm
melissawm approved these changes Apr 6, 2024
View reviewed changes
Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah great! I was working on this too, so will submit a parallel PR but please let's merge this one first 😄

docs/naps/9-multiple-canvases.md
Comment on lines +167 to +168
(nap_9_design_and_architecture)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually we can just use the old label, what doesn't work is the capitalization. So we can just change the reference to read (#ui-design-and-architecture)

docs/naps/9-multiple-canvases.md
### UI Design and Architecture
Specific UI design and architecture remains to be determined. This will be explored as part of step 4 in the [Implementation Plan](#Implementation). UI design needs additional refinement and exploration, and this is expected to continue after basic/core implementation propsed in this NAP is complete. UI changes may also be described in a separate NAP along with a discussion of convenience functions and affordances for common operations. Some placeholder or experimental code will be used in the meantime as a prototype implementation.
Specific UI design and architecture remains to be determined. This will be explored as part of step 4 in the [Implementation Plan](nap_9_implementation). UI design needs additional refinement and exploration, and this is expected to continue after basic/core implementation propsed in this NAP is complete. UI changes may also be described in a separate NAP along with a discussion of convenience functions and affordances for common operations. Some placeholder or experimental code will be used in the meantime as a prototype implementation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, using just (#implementation) works

docs/tutorials/processing/dask.md
@@ -205,7 +207,7 @@ directory. The dataset is 3.69 GB unzipped.
```

While we could use plain `dask` through `delayed`, as we have shown above, we
will [make our lives easier](make-your-life-easier-with-dask-image) here and use
will [make our lives easier](dask_images) here and use
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfectly fine to create a new target, but FYI if we do [make our lives easier](#make-your-life-easier-with-dask-image) the automatic label works.

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Apr 7, 2024 •
edited
Loading

Thanks for the explanations @melissawm
I think I lean to those fixes vs. the new references, because they are unlikely to be used outside the nap.

@lucyleeow
Copy link
Collaborator Author

@melissawm I will close this as you already address these in your #393 PR

@lucyleeow lucyleeow closed this Apr 7, 2024
@lucyleeow lucyleeow deleted the fix_warnings branch April 7, 2024 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@psobolewskiPhD psobolewskiPhD psobolewskiPhD requested changes

@melissawm melissawm melissawm approved these changes

Assignees

@lucyleeow lucyleeow

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.5.0
Development

Successfully merging this pull request may close these issues.
3 participants
@lucyleeow @psobolewskiPhD @melissawm